解決しやすい技術相談について考えてみた

この記事はアノテーション株式会社 AWS Technical Support Advent Calendar 2021のカレンダー | Advent Calendar 2021 - Qiita 18日目の記事です。

はじめに

アノテーションの荒川です。

私はクラスメソッドメンバーズで AWS に関するテクニカルサポート業務を担当しています。

テクニカルサポート業務では、お客様から頂いたお問い合わせの対応方針を決める機会が多くあります。

今回は対応方針がスムーズに決められやすいお問い合わせ、すなわち解決しやすい相談について、私が普段から感じることを書きます。

シンプルなことですが、解決しやすい相談には相手に伝わりやすい文章を書くことが大切です。

技術的な相談をする機会がある方、今まで相談したことはあるけど上手くいかなかったと感じる方に読んでもらえたら幸いです。

※ 本記事は Web 上のテキストコミュニケーションの相談を想定しています。

要約

この記事の要約は以下のとおりです。

相談をするときは

• 相手に何を答えて欲しいか伝える
• 自分が何に困っているか伝える
• 平易で簡潔な文章を目指す
• 引用や参考記事の抜粋を使う
• 文章に見出しをつける

文章を送信する前に

• 入力した項目や選択肢をチェックしよう
• 声に出して読みやすい文章かチェックしよう

それでも不安なら

• 相談する前に誰かに見てもらう

その他

• テキスト校正ツールを使う

解決しやすい相談例

「負荷分散環境で Cookie の利用が適していないのはなぜ？」を問題とした良い相談例を紹介します。

相談テンプレート例

相談テンプレート例を紹介します。

相談をするときは

相手に何を答えて欲しいか伝える

何を答えて欲しいかわからない相談に対して、テクニカルサポートは以下のような連絡をすることが多いです。

「お客様は○○をされたいと認識しております。恐れ入りますが、当方の認識に相違がございましたらご指摘ください。」

何故かというと、相談者と認識がずれたまま相談を続けると不満に繋がりやすいからです。

この認識のギャップを埋めるポイントは、相手に何を答えて欲しいか相談の先頭か末尾に記載することです。

複数の質問をする場合は、箇条書き（・）や項番（1.）を使うとより伝わりやすくなります。

自分が何に困っているか伝える

自分が困っていることについて、相談相手も同じように困るとは限りません。

たとえばテクニカルサポートのお問い合わせでは、相談内容がそもそもサービスの利用想定（ユースケース）と違うなどがあります。

この場合、困っていることや背景が記載されていれば、サポートからより良い回答を得られる可能性が高まります。

平易で簡潔な文章を目指す

「〜で、〜し、〜なので、〜のため、〜ですが、」など文を繋げていくと一文が複雑になります。

接続詞を使い一文を短くすると、より相談の回答が引き出しやすくなります。（ただし、過度に短くした文章は機械的な文章に見えます。）

一文が長いか短いか判断できないときは、文章を読み上げて自然に感じられたら良いでしょう。

基本的にテクニカルサポートは相手の質問を引用して回答します。

平易で簡潔な文章は引用しやすく、回答も平易で簡潔にしやすくなります。

引用や参考記事の抜粋を使う

URL やスクリーンショットを相談の文末に添えると効果的です。

参考とした情報に相談の回答が記載されていることもありますので、どの箇所をどこまで読んだのか（操作したのか）も記載すると相談がより解決しやすくなります。

相談時に「ドキュメントのステップ 5 まで試したところで先へ進めなくなり困っています。」と記載すれば「ステップ 4 でエラーが出ている状況に見受けられますので、プロセスを再起動して再度ステップ 4 からお試しください。」といった回答ができるようになります。

テクニカルサポートでは相談者へ「ちゃんと読んでますか？」と返信することはできません。

参考にした情報がなく曖昧な相談を続けられると、相手の考えを推し量ることが続き精神的な負荷を感じる人は多いです。

文章に見出しをつける

どうしても文字数が多くなってしまう相談は、段落に見出しを付けましょう。

見出し文字は「○」や「◎」や「■」や「#」など、好きな文字を使えば良いと思います。

文字数が多くても各見出し内の文章が平易で簡潔であれば、テクニカルサポート側は回答がしやすいです。

文章を送信する前に

入力した項目や選択肢をチェックしよう

どんなに良い相談内容でも相談相手を誤ると時間の無駄になります。

相談事を送信する前に入力内容の確認をしましょう。

アナログな確認ですが、PC を使う操作でも指差し確認は意外と有効です。

声に出して読みやすい文章かチェックしよう

声に出して読みづらい文章は、相談相手が読みづらい文章です。

相談事を送信する前に声に出して確認をしましょう。

声に出せない環境では、心の中で読み上げることも効果的です。

それでも不安なら

相談する前に誰かに見てもらう

同僚や周りの人に相談してみてください。

自分では平易で簡潔な文章を書いているつもりでも、別の人が見ると読みづらい文章かもしれません。

文章を読んだ人が感じる「解釈の幅」をなくすのがより良い相談ですが、「解釈」自体が人によって様々なので相談する価値はあります。

その他

テキスト校正ツールを使う

私は Visual Studio Code の拡張機能であるテキスト校正くん - Visual Studio Marketplaceを使っています。

どんなに文章力に自信があっても機械的なチェックはした方が良いと思います。

解決しやすい相談例

相談例（挨拶省略）

■ やりたいこと
負荷分散環境の Web アプリケーションでセッション維持を目的に Cookie を利用したいです。

■ 困っていること・背景
アプリケーションエンジニアから負荷分散のオートスケーリング環境で Cookie の利用は適していないと指摘されました。
インターネットから ELB 経由でアプリケーションへ直接アクセスして動作確認をしているのですが、
今の所は問題が出ないので本当に適していないのか疑問に思っています。

■ 質問
負荷分散環境で Cookie を使い続けても問題ないのでしょうか？

■ 参考にしたドキュメント
Application Load Balancer のスティッキーセッション - Elastic Load Balancing
https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/application/sticky-sessions.html
> Application Load Balancer は、期間ベースの Cookie とアプリケーションベースの Cookie の両方をサポートします。

上記ドキュメントの内容から Cookie が正式にサポートされているように見えます。

上記のような相談を貰えれば、私は以下のような回答をします。

回答例（挨拶省略）

質問に回答します。

> 負荷分散環境で Cookie を使い続けても問題ないのでしょうか？

問題になる可能性があります。
ELB を利用した負荷分散環境（セッションの維持設定: 有効）で Cookie を使い続けると、
特定のクライアントからのリクエストが特定のターゲットに偏ります。
また、ターゲットで障害が発生した際にセッション情報が失われる可能性もあります。

アプリケーションエンジニアの指摘の通りですが、負荷分散の
オートスケーリング環境で Cookie の利用は適しておりません。

応答速度が求められる環境では ElastiCache の利用を、
Key-Value のデータストアが必要であれば DynamoDB に
セッション情報を退避させることを検討してください。

その他にもご不明な点があればご相談ください。

■ 参考情報
- Application Load Balancer のスティッキーセッション - Elastic Load Balancing
https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/application/sticky-sessions.html
===== 抜粋 =====
ユーザーのセッション中のすべてのリクエストが同じターゲットに送信されます。
===== 抜粋 =====

相談テンプレート例

相談する時にコピーして使ってみると良いかもしれません。ご自身の責任のもと、ご自由にお使いください。

[質問/確認事項]

[状況/背景]

[目的]

[作成されたリソース名など]

[問題の発生場所]

[参照したURLとつまずいた箇所]

おわりに

私は経験を積むことで解決しやすい相談ができるとは考えていません。

自分自身が常日頃そう感じているので、ブログにして振り返りしやすくしています。

数カ月後にこのブログを見直して、自分で改めようと思うこともあるでしょう。

とくに「声に出して読みやすい文章か」はオペレーションミスの予防にも繋がるのでオススメしたいです。

また、テンプレートを用意すると文章構成が統一できます。

組織やチーム単位で使ってみると相談が円滑に行えるかもしれません。

参考資料

アノテーション株式会社について

アノテーション株式会社は、クラスメソッド社のグループ企業として「オペレーション・エクセレンス」を担える企業を目指してチャレンジを続けています。「らしく働く、らしく生きる」のスローガンを掲げ、さまざまな背景をもつ多様なメンバーが自由度の高い働き方を通してお客様へサービスを提供し続けてきました。現在当社では一緒に会社を盛り上げていただけるメンバーを募集中です。少しでもご興味あれば、アノテーション株式会社WEBサイトをご覧ください。